feat: [Ecosystem > Node > Overview] Improve article #953
Conversation
|
To fix the formatting issues:
npx remark -o --silent --silently-ignore ecosystem/node/overview.mdx |
|
@aigerimu include ton repo |
|
Thanks for the docs updates around the node overview. A couple of high‑severity anchor issues need fixes before merge. Findings (2)High (2)[HIGH] Broken internal anchor for “Single nominator”Location: docs/ecosystem/node/overview.mdx Line 27 in 5d0bdfb Description: Suggestion: - | [Single nominator](/ecosystem/node/overview#liquid-staking) | In this mode, the smart contract accepts stakes from a single user and operates a validator on the user’s behalf, distributing rewards securely using a cold wallet. |
+ | [Single nominator](/ecosystem/node/overview#single-nominator-pool) | In this mode, the smart contract accepts stakes from a single user and operates a validator on the user’s behalf, distributing rewards securely using a cold wallet. |[HIGH] Broken internal anchor to config parameter 16Location: docs/ecosystem/node/overview.mdx Line 39 in 5d0bdfb Description: Suggestion: - Validator nodes or validators are the TON network participants who propose new blocks and verify transactions according to TON's [_proof-of-stake_](https://en.wikipedia.org/wiki/Proof_of_stake) mechanism. The top 400 validators are selected based on network [configuration parameter](/foundations/config#param-16%3A-validators-limits). Validators receive rewards for validation.
+ Validator nodes or validators are the TON network participants who propose new blocks and verify transactions according to TON's [_proof-of-stake_](https://en.wikipedia.org/wiki/Proof_of_stake) mechanism. The top 400 validators are selected based on network [configuration parameter](/foundations/config#param-16-validators-limits). Validators receive rewards for validation. |
|
To fix the formatting issues:
npx remark -o --silent --silently-ignore ecosystem/node/overview.mdx |
Added details about Liteserver and Validator nodes, including references for commands in mytonctrl.
|
To fix the formatting issues:
npx remark -o --silent --silently-ignore ecosystem/node/overview.mdx |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| | [Nominator pool](/ecosystem/node/overview#nominator-pool) | In this mode, the smart contract accepts stakes from multiple users and operates a validator on their behalf, distributing rewards securely among participants. | | ||
| | [Single nominator](/ecosystem/node/overview#liquid-staking) | In this mode, the smart contract accepts stakes from a single user and operates a validator on the user’s behalf, distributing rewards securely using a cold wallet. | |
There was a problem hiding this comment.
[HIGH] Broken/misdirected anchors in modes table
Two links in “MyTonCtrl management modes” are incorrect. “Nominator pool” points to #nominator-pool, but the actual section heading is “Nominator pools”, so the anchor must be #nominator-pools. “Single nominator” points to #liquid-staking, which is the wrong section and misleads readers. Broken/missing anchors are HIGH by the style guide; see https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L625-L629 and https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L31-L31.
| | [Nominator pool](/ecosystem/node/overview#nominator-pool) | In this mode, the smart contract accepts stakes from multiple users and operates a validator on their behalf, distributing rewards securely among participants. | | |
| | [Single nominator](/ecosystem/node/overview#liquid-staking) | In this mode, the smart contract accepts stakes from a single user and operates a validator on the user’s behalf, distributing rewards securely using a cold wallet. | | |
| | [Nominator pool](/ecosystem/node/overview#nominator-pools) | In this mode, the smart contract accepts stakes from multiple users and operates a validator on their behalf, distributing rewards securely among participants. | | |
| | [Single nominator](/ecosystem/node/overview#single-nominator) | In this mode, the smart contract accepts stakes from a single user and operates a validator on the user’s behalf, distributing rewards securely using a cold wallet. | |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| <Aside type="note">A [reference](/ecosystem/node/mytonctrl/pools) for nominator-related commands is available in mytonctrl.</Aside> | ||
|
|
||
| Full and archive nodes typically enable liteserver mode because they store blockchain history and handle external requests. In contrast, validator nodes do not need it as they focus on validating new blocks efficiently without extra workload from external queries. | ||
| ### Liquid staking |
There was a problem hiding this comment.
[HIGH] Missing anchor target for “single-nominator”
The modes table deep-links to #single-nominator, but there is no corresponding section heading to define this anchor. This creates a broken link path for readers. Anchors must resolve correctly; absence of the target is HIGH severity per the style guide.
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| | Validator or nominator | [Setting up a node using MyTonCtrl](./setup-mytonctrl) with validator, nominator pool, or single nominator workflows. MyTonCtrl automates validator wallets, overlays, elections, and upgrades. | | ||
| | Liteserver APIs | [Setting up a node using MyTonCtrl](./setup-mytonctrl) with liteserver mode. Enable archive mode if required. | | ||
| | Isolated development network | [Setting up a local blockchain using MyLocalTon](./setup-mylocalton) with a local shard, explorer, and APIs for development and testing without affecting the mainnet. | |
There was a problem hiding this comment.
[HIGH] Relative internal links violate root-absolute rule
The environment selection table uses relative link segments (./setup-mytonctrl, ./setup-mylocalton). Per the style guide, internal links must be root-absolute and anchors must resolve correctly; relative segments are prohibited. This is a HIGH-severity rule. See https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L625-L629 for the normative requirement.
| | Validator or nominator | [Setting up a node using MyTonCtrl](./setup-mytonctrl) with validator, nominator pool, or single nominator workflows. MyTonCtrl automates validator wallets, overlays, elections, and upgrades. | | |
| | Liteserver APIs | [Setting up a node using MyTonCtrl](./setup-mytonctrl) with liteserver mode. Enable archive mode if required. | | |
| | Isolated development network | [Setting up a local blockchain using MyLocalTon](./setup-mylocalton) with a local shard, explorer, and APIs for development and testing without affecting the mainnet. | | |
| | Validator or nominator | [Setting up a node using MyTonCtrl](/ecosystem/node/setup-mytonctrl) with validator, nominator pool, or single nominator workflows. MyTonCtrl automates validator wallets, overlays, elections, and upgrades. | | |
| | Liteserver APIs | [Setting up a node using MyTonCtrl](/ecosystem/node/setup-mytonctrl) with liteserver mode. Enable archive mode if required. | | |
| | Isolated development network | [Setting up a local blockchain using MyLocalTon](/ecosystem/node/setup-mylocalton) with a local shard, explorer, and APIs for development and testing without affecting the mainnet. | |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
|
/review |
| | :---------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | [Liteserver](/ecosystem/node/overview#liteserver) | In this mode, node keeps the latest shardchain state and serves it to lite clients — external services that request blockchain data. For example, it provides up-to-date blockchain data for wallets. | | ||
| | [Archive liteserver](/ecosystem/node/overview#archive-liteserver) | In this mode, node stores all blockchain data, including old blocks and states. For example, it serves explorers with historical data. | | ||
| | [Validator](/ecosystem/node/overview#validator) | In this mode, node signs blocks, participates in elections, and earns rewards. It is used to run validation with your stake. | |
There was a problem hiding this comment.
[HIGH] Prohibited second‑person pronoun in Validator row
The validator row contains “It is used to run validation with your stake.”, which addresses the reader via “your”. This violates the prohibition on “you/your” (https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L169-L171). Revise to neutral phrasing that does not assume reader identity.
| | [Validator](/ecosystem/node/overview#validator) | In this mode, node signs blocks, participates in elections, and earns rewards. It is used to run validation with your stake. | | |
| | [Validator](/ecosystem/node/overview#validator) | In this mode, the node signs blocks, participates in elections, and earns rewards. Used to run validation with a validator’s stake. | |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| | [Archive liteserver](/ecosystem/node/overview#archive-liteserver) | In this mode, node stores all blockchain data, including old blocks and states. For example, it serves explorers with historical data. | | ||
| | [Validator](/ecosystem/node/overview#validator) | In this mode, node signs blocks, participates in elections, and earns rewards. It is used to run validation with your stake. | | ||
| | [Collator](/ecosystem/node/overview#collator) | In this mode, node produces blocks for validators. It reduces load on the validators by setting up block creation on a separate host machine. | | ||
| | [Nominator pool](/ecosystem/node/overview#nominator-pool) | In this mode, the smart contract accepts stakes from multiple users and operates a validator on their behalf, distributing rewards securely among participants. | |
There was a problem hiding this comment.
[HIGH] Broken/mismatched anchor in “Nominator pool” link
The table links to /ecosystem/node/overview#nominator-pool (singular), but the section heading is “### Nominator pools” (plural, line 54), which generates the anchor #nominator-pools. This makes the link non-functional. Anchors must resolve correctly per https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L625-L629.
| | [Nominator pool](/ecosystem/node/overview#nominator-pool) | In this mode, the smart contract accepts stakes from multiple users and operates a validator on their behalf, distributing rewards securely among participants. | | |
| | [Nominator pool](/ecosystem/node/overview#nominator-pools) | In this mode, the smart contract accepts stakes from multiple users and operates a validator on their behalf, distributing rewards securely among participants. | |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| </Aside> | ||
|
|
||
| **Validator nodes** or **validators** are the TON network participants who propose new blocks and verify transactions according to the TON's _proof-of-stake_ mechanism. In this way, validators contribute to the overall blockchain security. | ||
| Validator nodes or validators are the TON network participants who propose new blocks and verify transactions according to TON's [_proof-of-stake_](https://en.wikipedia.org/wiki/Proof_of_stake) mechanism. The top 400 validators are selected based on network [configuration parameter](/foundations/config#param-16%3A-validators-limits). Validators receive rewards for validation. |
There was a problem hiding this comment.
[HIGH] Broken config anchor and unofficial “proof‑of‑stake” link
This line has two issues: it links “proof‑of‑stake” to Wikipedia instead of the internal canonical page (/foundations/consensus), and it links to /foundations/config#param-16%3A-validators-limits using a colon-encoded anchor that does not exist. The actual heading is “## Param 16: validators limits” which resolves to #param-16-validators-limits (see
Lines 264 to 266 in 2e7f225
| Validator nodes or validators are the TON network participants who propose new blocks and verify transactions according to TON's [_proof-of-stake_](https://en.wikipedia.org/wiki/Proof_of_stake) mechanism. The top 400 validators are selected based on network [configuration parameter](/foundations/config#param-16%3A-validators-limits). Validators receive rewards for validation. | |
| Validator nodes or validators are the TON network participants who propose new blocks and verify transactions according to TON's [_proof-of-stake_](/foundations/consensus) mechanism. The top 400 validators are selected based on network [configuration parameter](/foundations/config#param-16-validators-limits). Validators receive rewards for validation. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| ## When to run your own node | ||
|
|
||
| - **Use public endpoints when:** | ||
| - building prototypes or light integrations. | ||
|
|
||
| <Aside | ||
| type={"note"} | ||
| > | ||
| Liteservers and [APIs](/ecosystem/api/overview) offer read access to blockchain data and support transaction submission to the network. | ||
| </Aside> | ||
|
|
||
| - **Run your own full node when:** | ||
| - running a validator or staking service. | ||
| - guaranteed uptime or high-volume access beyond third-party limits is required. |
There was a problem hiding this comment.
[HIGH] Prohibited second‑person pronouns in section heading and list
The heading “When to run your own node” and the list item “Run your own full node when:” use second‑person pronouns (“your”), which is prohibited by the style guide (https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L169-L171). Documentation must avoid addressing the reader directly. The lines above are in the PR diff; revise to neutral, imperative language.
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| | Validator or nominator | [Setting up a node using MyTonCtrl](./setup-mytonctrl) with validator, nominator pool, or single nominator workflows. MyTonCtrl automates validator wallets, overlays, elections, and upgrades. | | ||
| | Liteserver APIs | [Setting up a node using MyTonCtrl](./setup-mytonctrl) with liteserver mode. Enable archive mode if required. | | ||
| | Isolated development network | [Setting up a local blockchain using MyLocalTon](./setup-mylocalton) with a local shard, explorer, and APIs for development and testing without affecting the mainnet. | |
There was a problem hiding this comment.
[HIGH] Relative internal links used
The table rows use relative link URLs starting with ./, which violates the style rule requiring root-absolute paths for internal links. This increases breakage risk during future file moves and within embed contexts. See https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L625-L629 for the link target/format rule. The lines above are in the PR diff and introduce these relative URLs.
| | Validator or nominator | [Setting up a node using MyTonCtrl](./setup-mytonctrl) with validator, nominator pool, or single nominator workflows. MyTonCtrl automates validator wallets, overlays, elections, and upgrades. | | |
| | Liteserver APIs | [Setting up a node using MyTonCtrl](./setup-mytonctrl) with liteserver mode. Enable archive mode if required. | | |
| | Isolated development network | [Setting up a local blockchain using MyLocalTon](./setup-mylocalton) with a local shard, explorer, and APIs for development and testing without affecting the mainnet. | | |
| | Validator or nominator | [Setting up a node using MyTonCtrl](/ecosystem/node/setup-mytonctrl) with validator, nominator pool, or single nominator workflows. MyTonCtrl automates validator wallets, overlays, elections, and upgrades. | | |
| | Liteserver APIs | [Setting up a node using MyTonCtrl](/ecosystem/node/setup-mytonctrl) with liteserver mode. Enable archive mode if required. | | |
| | Isolated development network | [Setting up a local blockchain using MyLocalTon](/ecosystem/node/setup-mylocalton) with a local shard, explorer, and APIs for development and testing without affecting the mainnet. | |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| import { Aside } from "/snippets/aside.jsx"; | ||
|
|
||
| ## Full node modes | ||
| A blockchain full node is software that stores the current state of the [shardchains](/foundations/shards) defined in the node's configuration. |
There was a problem hiding this comment.
Factually incorrect: that's not what it really stores.
fixes #936